Rename vendor error code and update documentation #316
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is done to better reflect the purpose of the field, which is to provide a vendor-specific diagnostic code for the error or the warning that the sensor is reporting. The term "diagnostic" is more appropriate than "error" in this context, as it encompasses both errors and warnings. Signed-off-by: Tiyash Basu <[email protected]>
github-actions
bot
added
the
part:protobuf
tiyash-basu-frequenz
changed the title
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the field name for vendor provided error codes in both sensor and electrical component diagnostics for improved clarity.
- Changed "vendor_error_code" to "vendor_diagnostic_code" in sensors.proto and electrical_components.proto.
- Updated inline comments to clarify error state conditions, with additional notes added to electrical_components.proto regarding unique state members and error population.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Renamed vendor error field and updated comments for clearer diagnostics in SensorDiagnostic messages. |
| proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto | Renamed vendor error field and revised state error documentation in ElectricalComponentState. |
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto
Outdated
Show resolved
Hide resolved
tiyash-basu-frequenz
added
the
cmd:skip-release-notes
tiyash-basu-frequenz
force-pushed
the
rename_vendor_error_code
branch
from
2f5b96a to
88a4907
Compare
florian-wagner-frequenz
left a comment
florian-wagner-frequenz
left a comment
There was a problem hiding this comment.
LGTM, although I am not sure of the impact that the name change might have on the API (how long did this field exist, is anyone using it already?)
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto
Outdated
Show resolved
Hide resolved
thomas-nicolai-frequenz
previously approved these changes
May 5, 2025
Contributor
There was a problem hiding this comment.
LGTM, but please check the comments by @florian-wagner-frequenz .
Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
rename_vendor_error_code
branch
from
88a4907 to
7912d10
Compare
tiyash-basu-frequenz
requested review from
Copilot,
florian-wagner-frequenz and
thomas-nicolai-frequenz
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR renames the vendor error code field to vendor diagnostic code and updates the related documentation in the proto files to clarify that list fields are treated as sets (i.e., no duplicates) and to detail behavior when in an error state.
- Renames "vendor_error_code" to "vendor_diagnostic_code" in both sensors.proto and electrical_components.proto.
- Updates documentation comments for list fields (states, warnings, errors) to explicitly state uniqueness and error state behavior.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Renamed vendor error field and refined comments for list uniqueness and error warning handling. |
| proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto | Renamed vendor error field and updated comments to clarify uniqueness and error state details in component states. |
florian-wagner-frequenz
approved these changes
May 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.